gridpack::component::GenMatVecInterface Class Reference

#include <base_component.hpp>

Inheritance diagram for gridpack::component::GenMatVecInterface:

[legend]

List of all members.

Public Member Functions
	GenMatVecInterface (void)
virtual	~GenMatVecInterface (void)
virtual int	matrixNumRows () const
virtual int	matrixNumCols () const
virtual void	matrixSetRowIndex (int irow, int idx)
virtual void	matrixSetColIndex (int icol, int idx)
virtual int	matrixGetRowIndex (int irow)
virtual int	matrixGetColIndex (int icol)
virtual int	matrixNumValues () const
virtual void	matrixGetValues (ComplexType *values, int *rows, int *cols)
virtual void	matrixGetValues (RealType *values, int *rows, int *cols)
virtual int	vectorNumElements () const
virtual void	vectorSetElementIndex (int ielem, int idx)
virtual void	vectorGetElementIndices (int *idx)
virtual void	vectorGetElementValues (ComplexType *values, int *idx)
virtual void	vectorGetElementValues (RealType *values, int *idx)
virtual void	vectorSetElementValues (ComplexType *values)
virtual void	vectorSetElementValues (RealType *values)
virtual void	slabSize (int *rows, int *cols) const
virtual void	slabSetRowIndex (int irow, int idx)
virtual void	slabGetRowIndices (int *idx)
virtual void	slabGetValues (std::vector< ComplexType * > &values, int *idx)
virtual void	slabGetValues (std::vector< RealType * > &values, int *idx)
virtual void	slabSetValues (ComplexType **values)
virtual void	slabSetValues (RealType **values)

---

Constructor & Destructor Documentation

gridpack::component::GenMatVecInterface::GenMatVecInterface

(

void

)

Constructor

virtual gridpack::component::GenMatVecInterface::~GenMatVecInterface

(

void

)

[virtual]

Destructor

---

Member Function Documentation

virtual int gridpack::component::GenMatVecInterface::matrixGetColIndex

(

int

icol

)

[virtual]

Get the column indices corresponding to the columns contributed by this component

Parameters:

icol

index of column contributed by this component (e.g. if component contributes 3 columns then icol is between 0 and 2)

Returns:

matrix index of column icol

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual int gridpack::component::GenMatVecInterface::matrixGetRowIndex

(

int

irow

)

[virtual]

Get the row indices corresponding to the rows contributed by this component

Parameters:

irow

index of row contributed by this component (e.g. if component contributes 3 rows then irow is between 0 and 2)

Returns:

matrix index of row irow

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual void gridpack::component::GenMatVecInterface::matrixGetValues	(	RealType *	values,
		int *	rows,
		int *	cols
	)			[virtual]

virtual void gridpack::component::GenMatVecInterface::matrixGetValues	(	ComplexType *	values,
		int *	rows,
		int *	cols
	)			[virtual]

Get a list of matrix values contributed by this component and their matrix indices

Parameters:

	values	list of matrix element values
	rows	row indices for the matrix elements
	cols	column indices for the matrix elements

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual int gridpack::component::GenMatVecInterface::matrixNumCols

(

)

const [virtual]

Return number of columns in matrix from component

Returns:

number of columnsows from component

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual int gridpack::component::GenMatVecInterface::matrixNumRows

(

)

const [virtual]

Return number of rows in matrix from component

Returns:

number of rows from component

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual int gridpack::component::GenMatVecInterface::matrixNumValues

(

)

const [virtual]

Return the number of matrix values contributed by this component

Returns:

number of matrix values

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual void gridpack::component::GenMatVecInterface::matrixSetColIndex	(	int	icol,
		int	idx
	)			[virtual]

Set column indices corresponding to the columns contributed by this component

Parameters:

	icol	index of column contributed by this component (e.g. if component contributes 3 columns then icol is between 0 and 2)
	idx	matrix index of column icol

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual void gridpack::component::GenMatVecInterface::matrixSetRowIndex	(	int	irow,
		int	idx
	)			[virtual]

Set row indices corresponding to the rows contributed by this component

Parameters:

	irow	index of row contributed by this component (e.g. if component contributes 3 rows then irow is between 0 and 2)
	idx	matrix index of row irow

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual void gridpack::component::GenMatVecInterface::slabGetRowIndices

(

int *

idx

)

[virtual]

Get list of row indices from component

Parameters:

idx

list of row indices that component maps onto

virtual void gridpack::component::GenMatVecInterface::slabGetValues	(	std::vector< RealType * > &	values,
		int *	idx
	)			[virtual]

virtual void gridpack::component::GenMatVecInterface::slabGetValues	(	std::vector< ComplexType * > &	values,
		int *	idx
	)			[virtual]

Get a list of row values contributed by this component and their indices

Parameters:

	values	list of values for rows
	idx	indices for the matrix rows

virtual void gridpack::component::GenMatVecInterface::slabSetRowIndex	(	int	irow,
		int	idx
	)			[virtual]

Set indices corresponding to the rows contributed by this component

Parameters:

	irow	index of row contributed by this component (e.g. if component contributes 3 rows then irow is between 0 and 2)
	idx	row index of row irow

virtual void gridpack::component::GenMatVecInterface::slabSetValues

(

RealType **

values

)

[virtual]

virtual void gridpack::component::GenMatVecInterface::slabSetValues

(

ComplexType **

values

)

[virtual]

Transfer slab values to component

Parameters:

values

list of slab values

virtual void gridpack::component::GenMatVecInterface::slabSize	(	int *	rows,
		int *	cols
	)			const [virtual]

Return number of rows and columns in matrix from component Number of columns must be the same for all components

Returns:

size of block contributed by component

virtual void gridpack::component::GenMatVecInterface::vectorGetElementIndices

(

int *

idx

)

[virtual]

Get list of element indices from component

Parameters:

idx

list of indices that component maps onto

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual void gridpack::component::GenMatVecInterface::vectorGetElementValues	(	RealType *	values,
		int *	idx
	)			[virtual]

virtual void gridpack::component::GenMatVecInterface::vectorGetElementValues	(	ComplexType *	values,
		int *	idx
	)			[virtual]

Get a list of vector values contributed by this component and their indices

Parameters:

	values	list of vector element values
	idx	indices for the vector elements

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual int gridpack::component::GenMatVecInterface::vectorNumElements

(

)

const [virtual]

Return number of elements in vector from component

Returns:

number of elements contributed from component

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual void gridpack::component::GenMatVecInterface::vectorSetElementIndex	(	int	ielem,
		int	idx
	)			[virtual]

Set indices corresponding to the elements contributed by this component

Parameters:

	ielem	index of element contributed by this component (e.g. if component contributes 3 elements then ielem is between 0 and 2)
	idx	vector index of element ielem

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

virtual void gridpack::component::GenMatVecInterface::vectorSetElementValues

(

RealType *

values

)

[virtual]

virtual void gridpack::component::GenMatVecInterface::vectorSetElementValues

(

ComplexType *

values

)

[virtual]

Transfer vector values to component

Parameters:

values

list of vector element values

Reimplemented in gridpack::state_estimation::SEBus, and gridpack::state_estimation::SEBranch.

---

The documentation for this class was generated from the following file:

• base_component.hpp